FlowGroup Methods
An object defining methods for the FlowGroup class.
SendApprovalWebNotification(userInfo, requestItem)
Sends a web notification for approval to the specified user.
Parameters:
userInfo (required): UserInfo
Information about the user receiving the notification.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddDocument(flowDocument, viewName, viewId, panelSize, allowEdit, showEvents)
Adds a document to the workflow group with various display options.
Parameters:
flowDocument (required): FlowDocument
The document to be added to the group.
viewName (optional): string
The name of the view associated with the document.
viewId (optional): string
The ID of the view associated with the document.
panelSize (optional): PanelSize
The size of the panel where the document will be displayed.
allowEdit (optional): bool
Indicates whether the document can be edited.
showEvents (optional): bool
Specifies whether events related to the document should be displayed.
Returns:
Type: bool
Returns true if the document was added successfully, otherwise false.
This is a sync method. Method runs synchronously.
AddConstantUser(id, userName, userCode)
Adds a constant user to the workflow group with additional details.
Parameters:
id (required): long
The unique identifier of the user to be added.
userName (required): string
The name of the user to be added.
userCode (required): string
The code representing the user to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddConstantPosition(id)
Adds a constant position to the workflow group using its ID.
Parameters:
id (required): long
The unique identifier of the position to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
IsEmpty()
Checks if the workflow group has no members or positions.
Returns:
Type: bool
Returns true if the group is empty, otherwise false.
This is a sync method. Method runs synchronously.
ClearGroup()
Clears all members, positions, and related settings from the workflow group.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendWebNotification(payloadType,userInfo,requestItem)
Sends a web notification to a user.
Parameters:
payloadType (required): MessagePayloadType
The type of the web notification payload.
userInfo (required): UserInfo
The user to whom the web notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddConstantPosition(id, positionCode, positionDescription)
Adds a constant position to the workflow group with additional details.
Parameters:
id (required): long
The unique identifier of the position to be added.
positionCode (required): string
The code of the position to be added.
positionDescription (required): string
A description of the position to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddConstantUser(id)
Adds a constant user to the workflow group using their ID.
Parameters:
id (required): long
The unique identifier of the user to be added.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
GetUserInfo(requestItem)
Retrieves user information for a given process request item.
Parameters:
requestItem (required): ProcessRequestItem
The process request item to retrieve user information for.
Returns:
Type: Task<UserInfo>
The user information for the given process request item.
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SendRequestTimedOutWebNotification(userInfo, requestItem)
Sends a real-time notification to the user indicating that the request has timed out, prompting the client to close any related open forms.
Parameters:
userInfo (required): UserInfo
Information about the user receiving the notification.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendMail(requestItem, userInfo)
Sends an email to a user associated with the process request.
Parameters:
requestItem (required): ProcessRequestItem
The process request item containing workflow details.
userInfo (required): UserInfo
Information about the user to whom the email will be sent.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
AddDepartmentBasedUserGroup(departmentId, titleId)
Adds a user group based on department and title to the workflow group.
Parameters:
departmentId (required): long
The unique identifier of the department.
titleId (optional): long
The unique identifier of the title within the department.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
Initialize()
Initializes the workflow group with default configurations.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
RemoveDocument(flowDocument)
Removes a document from the workflow group.
Parameters:
flowDocument (required): FlowDocument
The document to be removed from the group.
Returns:
Type: bool
Returns true if the document was removed successfully, otherwise false.
This is a sync method. Method runs synchronously.
ToLiquid()
Converts the workflow group configuration into a Liquid-compatible format.
Returns:
Type: object
The converted object.
This is a sync method. Method runs synchronously.
AddAttachment(value,type)
Adds an attachment to the mail message.
Parameters:
value (required): string
Value of the attachment.
type (required): MailAttachmentType
Type of the attachment.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendRequestsCanceledWebNotification(userInfo, requestItem)
Sends a real-time notification to the user indicating that the current request has been canceled, prompting the client to close any associated open forms.
Parameters:
userInfo (required): UserInfo
Information about the user receiving the notification.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendPushNotification(userInfo,requestItem)
Sends a push notification to a user.
Parameters:
userInfo (required): UserInfo
The user to whom the push notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.